Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Enhance widget rendering to ensure that the active Widget is always visible #258

Merged
merged 1 commit into from
Oct 27, 2024
Merged

Enhance widget rendering to ensure that the active Widget is always visible #258

merged 1 commit into from
Oct 27, 2024

Conversation

forntoh
Copy link
Owner

@forntoh forntoh commented Oct 27, 2024 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • New Features

    • Enhanced widget rendering logic for better visibility and management.
    • Improved navigation and view reset when exiting edit mode.

  • Bug Fixes

    • Maintained error handling for active widget index constraints.

@forntoh
Adjust view shift for active widget visibility
f9a7020 
Calculate available space for widgets after text to adjust view shift ensuring the active widget is visible. Set view shift to 0 when exiting edit mode.
@forntoh forntoh added the feature New feature label Oct 27, 2024
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 27, 2024 •
edited
Loading

Walkthrough

The changes in this pull request focus on the BaseItemManyWidgets class, enhancing the draw method to improve widget rendering by calculating available space and adjusting the viewShift property. The back method now resets the viewShift to zero when exiting edit mode. Additionally, the control flow for rendering and widget interactions has been refined, while error handling in the setActiveWidget method remains unchanged. Overall, these modifications aim to enhance widget navigation and rendering functionality.

Changes

File Change Summary
src/BaseItemManyWidgets.h Enhanced draw method for better widget rendering; updated back method to reset viewShift on exit; refined control flow for widget interactions. Error handling in setActiveWidget remains unchanged.

Possibly related PRs

Suggested labels

enhancement

🐇 In the meadow, where widgets play,
A shift in view to brighten the day.
With space calculated, they dance and twirl,
As the rabbit hops, in a joyful whirl.
Back to the start, with a reset cheer,
Navigating smoothly, no worries here! 🌼

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Files that changed from the base of the PR and between 883d3d7 and f9a7020.

📒 Files selected for processing (1)
  • src/BaseItemManyWidgets.h (2 hunks)
🧰 Additional context used
📓 Learnings (1)
src/BaseItemManyWidgets.h (2)
Learnt from: forntoh
PR: forntoh/LcdMenu#248
File: src/BaseItemManyWidgets.h:58-75
Timestamp: 2024-10-21T20:10:40.945Z
Learning: In `src/BaseItemManyWidgets.h`, the `draw` method's buffer overflow is handled by each widget individually, so additional checks in this method are unnecessary.

Learnt from: forntoh
PR: forntoh/LcdMenu#248
File: src/BaseItemManyWidgets.h:0-0
Timestamp: 2024-10-21T14:31:02.588Z
Learning: In the `BaseItemManyWidgets::draw` method in `src/BaseItemManyWidgets.h`, it's necessary to call `renderer->drawItem(text, buf)` inside the loop to obtain the cursor position for correct blinker placement when in edit mode.
🔇 Additional comments (2)
src/BaseItemManyWidgets.h (2)

160-160: LGTM! Clean view shift reset.

Good practice to reset the view shift when exiting edit mode, ensuring a clean state for the next interaction.

66-70: LGTM! Smart view shift calculation for widget visibility.

The new logic intelligently calculates available space and adjusts the view shift to ensure the active widget remains visible during editing. This improves the user experience by automatically scrolling to show the active widget.

Let's verify the renderer's viewShift bounds handling:

✅ Verification successful

Let me analyze the renderer's viewShift handling based on the search results:

  1. The viewShift is properly bounded on the lower end (>= 0):

    • In MenuScreen.cpp, there's a check if (renderer->viewShift > 0) before decrementing
    • In BaseItemManyWidgets.h, it's set to 0 if index <= v_size

  2. The CharacterDisplayRenderer handles text drawing with viewShift:

    • Has dedicated drawText method that considers viewShift
    • Implements bounds checking for colon separator drawing
    • Calculates separate valueViewShift for value portion

Let's verify the upper bounds handling with one more check:

Let me try a different approach to check the effective columns handling:

View shift calculation is safe and properly bounded

The implementation is verified to be safe because:

  1. The renderer properly handles lower bounds (viewShift ≥ 0) through explicit checks
  2. Upper bounds are implicitly handled through:
    • Available columns calculation that accounts for UI elements (arrows, cursor icons)
    • Text drawing that stops at available columns (while (col < availableColumns))
    • Colon separator drawing with bounds check (cursorCol < availableColumns)
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if the renderer implements bounds checking for viewShift
rg -A 5 "viewShift" --type cpp

Length of output: 5361

Script:

#!/bin/bash
# Check for effective columns and bounds handling in renderer
ast-grep --pattern 'getEffectiveCols() {
  $$$
}'

Length of output: 51

Script:

#!/bin/bash
# Check for effective columns implementation and bounds handling
rg -A 5 "getEffectiveCols|availableColumns" --type cpp

Length of output: 4412

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@coderabbitai coderabbitai bot changed the title @coderabbitai Enhance BaseItemManyWidgets Class for Improved Widget Rendering and Navigation Oct 27, 2024
@forntoh forntoh added enhancement Improve readability/performance/maintainability and removed feature New feature labels Oct 27, 2024
@forntoh forntoh changed the title Enhance BaseItemManyWidgets Class for Improved Widget Rendering and Navigation Enhance BaseItemManyWidgets for Improved Widget Rendering Oct 27, 2024
@forntoh forntoh changed the title Enhance BaseItemManyWidgets for Improved Widget Rendering Enhance widget rendering to ensure that the active Widget is always visible Oct 27, 2024
@forntoh forntoh marked this pull request as ready for review October 27, 2024 14:51
@forntoh forntoh merged commit 45c7381 into master Oct 27, 2024
21 checks passed
@forntoh forntoh deleted the enhancement/widget-rendering branch October 27, 2024 14:54
@coderabbitai coderabbitai bot mentioned this pull request Oct 28, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] approved these changes

Assignees
No one assigned
Labels
enhancement Improve readability/performance/maintainability
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@forntoh